xml.dll - mIRC XML Parser DLL

Version 0.1.1, June 2003
©2003 sax & www.ScriptsDB.org

• Introduction
• Installation
• Utilisation du DLL
• Référence
• Fonctions de Création de Parsers
• create_parser
• free_parser
• Fonctions de Parsing de Fichiers
• set_file
• get_file
• parse_file
• Fonctions de Parsing de Buffers
• set_buffer
• free_buffer
• get_buffer
• get_buffer_len
• parse_buffer
• Fonctions des Handlers
• set_handler_startelement
• set_handler_endelement
• set_handler_attribute
• set_handler_startchardata
• set_handler_endchardata
• set_handler_chardata
• set_handler_startcomment
• set_handler_endcomment
• set_handler_comment
• set_handler_startcdata
• set_handler_endcdata
• set_handler_cdata
• set_handler_startprocessing
• set_handler_endprocessing
• set_handler_processing
• set_handler_startdefault
• set_handler_enddefault
• set_handler_default
• set_handler_xmldecl
• get_handler_startelement
• get_handler_endelement
• get_handler_attribute
• get_handler_startchardata
• get_handler_endchardata
• get_handler_chardata
• get_handler_startcomment
• get_handler_endcomment
• get_handler_comment
• get_handler_startcdata
• get_handler_endcdata
• get_handler_cdata
• get_handler_startprocessing
• get_handler_endprocessing
• get_handler_processing
• get_handler_startdefault
• get_handler_enddefault
• get_handler_default
• get_handler_xmldecl
• get_abspath
• Autres Fonctions
• dllinfo
• version
• Exemple de Script mIRC
• Versions Changes
• Auteur, Credits

/dll <xml.dll> <function> <parameters>
$dll(<xml.dll>,<function>,<parameters>)

• create_parser <name>

$dll(xml.dll,create_parser,demo)

• free_parser <name>

$dll(xml.dll,free_parser,demo)

• set_file <name> [xml_file]

$dll(xml.dll,set_file,demo config\settings.xml)

• get_file <name>

$dll(xml.dll,get_file,demo)

• parse_file <name>

$dll(xml.dll,parse_file,demo)

• set_buffer <name> [xml_string]

$dll(xml.dll,set_buffer,demo <node type="test">ok blah)
$dll(xml.dll,set_buffer,demo <bl0x/></node>)

• free_buffer <name>

$dll(xml.dll,free_buffer,demo)

• get_buffer <name> [start [len]]

$dll(xml.dll,get_buffer,demo)
$dll(xml.dll,get_buffer,demo 8 100)

• get_buffer_len <name>

$dll(xml.dll,get_buffer_len,demo)

• parse_buffer <name>

$dll(xml.dll,parse_buffer,demo)

• set_handler_startelement <name> [handler_alias]

<!-- XML -->
<element>
  <element />

; mIRC
$dll(xml.dll,set_handler_startelement,demo startel)
alias startel {
  ; $1 = demo
  ; $2 = nom de l'élément d'ouverture courant
}

$dll(xml.dll,set_handler_startelement,demo .signal -n startel)
on *:signal:startel: {
  ; $1 = demo
  ; $2 = nom de l'élément d'ouverture courant
}

• set_handler_endelement <name> [handler_alias]

<!-- XML -->
</element>
<element />

; mIRC
$dll(xml.dll,set_handler_endelement,demo endel)
alias endel {
  ; $1 = demo
  ; $2 = nom de l'élément de fermeture courant
}

• set_handler_attribute <name> [handler_alias]

<!-- XML -->
<element attrib="valeur"
         autre='autre valeur'>

; mIRC
$dll(xml.dll,set_handler_attribute,demo att)
alias att {
  ; $1 = demo
  ; $2 = nom de l'élément courant
  ; $3 = nom de l'attribut courant
  ; $4- = valeur de l'attribut
}

• set_handler_startchardata <name> [handler_alias]

<!-- XML -->
<element>debut de chardata

; mIRC
$dll(xml.dll,set_handler_startchardata,demo startdata)
alias startdata {
  ; $1 = demo
}

• set_handler_endchardata <name> [handler_alias]

<!-- XML -->
fin de chardata</element>

; mIRC
$dll(xml.dll,set_handler_endchardata,demo enddata)
alias enddata {
  ; $1 = demo
}

• set_handler_chardata <name> [handler_alias]

<!-- XML -->
<element>
  chardata
  autre ligne de chardata
</element>

; mIRC
$dll(xml.dll,set_handler_chardata,demo data)
alias data {
  ; $1 = demo
  ; $2- = valeur de la ligne de données courante
}

• set_handler_startcomment <name> [handler_alias]

<!-- XML -->
<!-- debut de commentaire

; mIRC
$dll(xml.dll,set_handler_startcomment,demo startcmt)
alias startcmt {
  ; $1 = demo
}

• set_handler_endcomment <name> [handler_alias]

<!-- XML -->
fin de commentaire -->

; mIRC
$dll(xml.dll,set_handler_endcomment,demo endcmt)
alias endcmt {
  ; $1 = demo
}

• set_handler_comment <name> [handler_alias]

<!-- XML -->
<!-- commentaire
  autre ligne de commentaire -->

; mIRC
$dll(xml.dll,set_handler_comment,demo cmt)
alias cmt {
  ; $1 = demo
  ; $2- = valeur de la ligne de commentaire courante
}

• set_handler_startcdata <name> [handler_alias]

<!-- XML -->
<![CDATA[ debut de CDATA

; mIRC
$dll(xml.dll,set_handler_startcdata,demo startcdat)
alias startcdat {
  ; $1 = demo
}

• set_handler_endcdata <name> [handler_alias]

<!-- XML -->
fin de CDATA ]]>

; mIRC
$dll(xml.dll,set_handler_endcdata,demo endcdat)
alias enddat {
  ; $1 = demo
}

• set_handler_cdata <name> [handler_alias]

<!-- XML -->
<![CDATA[
  CDATA
  autre ligne de CDATA
]]>

; mIRC
$dll(xml.dll,set_handler_cdata,demo cdat)
alias cdat {
  ; $1 = demo
  ; $2- = valeur de la ligne de CDATA courante
}

• set_handler_startprocessing <name> [handler_alias]

<!-- XML -->
<?spec debut de processing instructions

; mIRC
$dll(xml.dll,set_handler_startprocessing,demo startprocess)
alias startprocess {
  ; $1 = demo
}

• set_handler_endprocessing <name> [handler_alias]

<!-- XML -->
fin de processing instructions ?>

; mIRC
$dll(xml.dll,set_handler_endprocesing,demo endprocess)
alias endprocess {
  ; $1 = demo
}

• set_handler_processing <name> [handler_alias]

<!-- XML -->
<?spec processing instructions
  autre ligne de processing instructions
?>

; mIRC
$dll(xml.dll,set_handler_processing,demo process)
alias process {
  ; $1 = demo
  ; $2- = valeur de la ligne de processing instruction courante
}

• set_handler_startdefault <name> [handler_alias]

<!-- XML -->
<!ELEMENT debut d'entitée 'SGML' par défaut

; mIRC
$dll(xml.dll,set_handler_startdefault,demo startdef)
alias startdef {
  ; $1 = demo
}

• set_handler_enddefault <name> [handler_alias]

<!-- XML -->
fin d'entitée 'SGML' par défaut >

; mIRC
$dll(xml.dll,set_handler_enddefault,demo enddef)
alias enddef {
  ; $1 = demo
}

• set_handler_default <name> [handler_alias]

<!-- XML -->
<!ELEMENT BL0X - O EMPTY 
  -- client-side blah map bl0x -->

; mIRC
$dll(xml.dll,set_handler_default,demo def)
alias def {
  ; $1 = demo
  ; $2- = valeur de la ligne d'entitée par default courante
}

• set_handler_xmldecl <name> [handler_alias]

<?xml version="1.0" 
      encoding="ISO-8859-1" ?>

; mIRC
$dll(xml.dll,set_handler_xmldecl,demo xmld)
alias xmld {
  ; $1 = demo
  ; version: default 1.0
  ; $2 = 1.0
  ; encoding: default UTF-8
  ; $3 = ISO-8859-1
  ; standalone: default 1, 0 si standalone="no"
  ; $4 = 1
}

• get_handler_startelement <name>

• get_handler_endelement <name>

• get_handler_attribute <name>

• get_handler_startchardata <name>

• get_handler_endchardata <name>

• get_handler_chardata <name>

• get_handler_startcomment <name>

• get_handler_endcomment <name>

• get_handler_comment <name>

• get_handler_startcdata <name>

• get_handler_endcdata <name>

• get_handler_cdata <name>

• get_handler_startprocessing <name>

• get_handler_endprocessing <name>

• get_handler_processing <name>

• get_handler_startdefault <name>

• get_handler_enddefault <name>

• get_handler_default <name>

• get_handler_xmldecl <name>

• get_abspath <name>

• dllinfo

• version

<?xml version="1.0" encoding="ISO-8859-1" ?>

<!-- xmldemo.xml -->

<config>

  <server name="webnet">
    <address port="6667-7000">irc.webmatser.com</address>
    <nick>sax</nick>
    <perform type="on connect">
      <![CDATA[
        mode $me -nMpe
        ns identify sax mypass
      ]]>
    </perform>
  </server>

  <server name="localhost">
    <address>127.0.0.1</address>
  </server>

</config>

; /xmldemo

alias xmldemo {
  ; dll and .xml files
  var %dll = $+(",$scriptdirxml.dll,")
  var %xml = $scriptdirxmldemo.xml


  var %w = @xmldemo
  window -a %w | clear %w

  if (!$isfile(%dll)) { echo %w Error - missing: %dll | return }
  if (!$isfile(%xml)) { echo %w Error - missing: %xml | return }

  ; parser name
  var %n = demo

  echo %w Creating parser %n
  var %a = $dll(%dll,create_parser,%n)
  if (%a != S_OK) { echo %w Error - create_parser: %a | return }

  echo %w Setting handler aliases (commandes)
  dll %dll set_handler_xmldecl %n hxmldecl
  dll %dll set_handler_startelement %n hstartelement
  dll %dll set_handler_endelement %n hendelement
  dll %dll set_handler_attribute %n hattribute
  dll %dll set_handler_chardata %n hchardata
  dll %dll set_handler_cdata %n hcdata

  echo %w Setting XML file : %xml
  dll %dll set_file %n %xml

  ; global var: dll pathname will be use in start and end element handlers
  %xmldemo.dll = %dll

  echo %w Parsing :
  linesep %w
  var %a = $dll(%dll,parse_file,%n)
  if (%a != S_OK) { echo -a Error - parse_file: %a }

  linesep %w
  echo %w Deleting parser %n
  dll %dll free_parser %n

  ; unsets global var
  unset %xmldemo.*
}

; handler aliases (non local)

alias hxmldecl {
  echo @xmldemo XMLdecl (version, encoding, standalone): $2-
}

alias hstartelement {
  echo $color(notice) @xmldemo Startelement: $2 ( $dll(%xmldemo.dll,get_abspath,$1) )
}

alias hendelement {
  echo $color(notice) @xmldemo Endelement: $2 ( $dll(%xmldemo.dll,get_abspath,$1) )
}

alias hattribute {
  echo $color(join) @xmldemo Attribute: $2-
}

alias hchardata {
  echo @xmldemo Chardata: $2-
}

alias hcdata {
  echo @xmldemo CDATA: $2-
}

Anciennes	Nouvelles
CreateParser	create_parser
FreeParser	free_parser
File	set_file
ParseFile	parse_file
String	set_buffer
FreeString	free_buffer
ParseString	parse_buffer
StartElement	set_handler_startelement
EndElement	set_handler_endelement
Attribute	set_handler_attribute
Data	set_handler_chardata
DLLInfo	dllinfo


Ces anciennes fonctions sont toujours supportées mais ne sont plus documentées.